﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IStorageFile.cs" company="">
//   
// </copyright>
// <summary>
//   The StorageFile interface.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Skymate.Core.IO.Media
{
    using System;
    using System.IO;

    /// <summary>
    /// The StorageFile interface.
    /// </summary>
    public interface IStorageFile
    {
        /// <summary>
        /// The get path.
        /// </summary>
        /// <returns>
        /// The <see cref="string"/>.
        /// </returns>
        string GetPath();

        /// <summary>
        /// The get name.
        /// </summary>
        /// <returns>
        /// The <see cref="string"/>.
        /// </returns>
        string GetName();

        /// <summary>
        /// The get size.
        /// </summary>
        /// <returns>
        /// The <see cref="long"/>.
        /// </returns>
        long GetSize();

        /// <summary>
        /// The get last updated.
        /// </summary>
        /// <returns>
        /// The <see cref="DateTime"/>.
        /// </returns>
        DateTime GetLastUpdated();

        /// <summary>
        /// The get file type.
        /// </summary>
        /// <returns>
        /// The <see cref="string"/>.
        /// </returns>
        string GetFileType();

        /// <summary>
        /// Creates a stream for reading from the file.
        /// </summary>
        /// <returns>
        /// The <see cref="Stream"/>.
        /// </returns>
        Stream OpenRead();

        /// <summary>
        /// Creates a stream for writing to the file.
        /// </summary>
        /// <returns>
        /// The <see cref="Stream"/>.
        /// </returns>
        Stream OpenWrite();
    }
}